<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<title>FunctionMetadataRegistry (POI API Documentation)</title>
<link rel="stylesheet" type="text/css" href="../../../../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
    if (location.href.indexOf('is-external=true') == -1) {
        parent.document.title="FunctionMetadataRegistry (POI API Documentation)";
    }
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!--   -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FunctionMetadataRegistry.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadata.html" title="class in org.apache.poi.ss.formula.function"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html" target="_top">FRAMES</a></li>
<li><a href="FunctionMetadataRegistry.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_top");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!--   -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<p class="subTitle">org.apache.poi.ss.formula.function</p>
<h2 title="Class FunctionMetadataRegistry" class="title">Class FunctionMetadataRegistry</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.poi.ss.formula.function.FunctionMetadataRegistry</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public final class <strong>FunctionMetadataRegistry</strong>
extends java.lang.Object</pre>
<div class="block">Allows clients to get <a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadata.html" title="class in org.apache.poi.ss.formula.function"><code>FunctionMetadata</code></a> instances for any built-in function of Excel.</div>
<dl><dt><span class="strong">Author:</span></dt>
  <dd>Josh Micich</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!--   -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html#FUNCTION_INDEX_CHOOSE">FUNCTION_INDEX_CHOOSE</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html#FUNCTION_INDEX_EXTERNAL">FUNCTION_INDEX_EXTERNAL</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static int</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html#FUNCTION_INDEX_IF">FUNCTION_INDEX_IF</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html#FUNCTION_INDEX_INDIRECT">FUNCTION_INDEX_INDIRECT</a></strong></code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html#FUNCTION_INDEX_SUM">FUNCTION_INDEX_SUM</a></strong></code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html#FUNCTION_NAME_IF">FUNCTION_NAME_IF</a></strong></code>
<div class="block">The name of the IF function (i.e.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!--   -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd">&nbsp;</span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadata.html" title="class in org.apache.poi.ss.formula.function">FunctionMetadata</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html#getFunctionByIndex(int)">getFunctionByIndex</a></strong>(int&nbsp;index)</code>&nbsp;</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadata.html" title="class in org.apache.poi.ss.formula.function">FunctionMetadata</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html#getFunctionByName(java.lang.String)">getFunctionByName</a></strong>(java.lang.String&nbsp;name)</code>&nbsp;</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static short</code></td>
<td class="colLast"><code><strong><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html#lookupIndexByName(java.lang.String)">lookupIndexByName</a></strong>(java.lang.String&nbsp;name)</code>
<div class="block">Resolves a built-in function index.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!--   -->
</a>
<h3>Methods inherited from class&nbsp;java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!--   -->
</a>
<h3>Field Detail</h3>
<a name="FUNCTION_NAME_IF">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FUNCTION_NAME_IF</h4>
<pre>public static final&nbsp;java.lang.String FUNCTION_NAME_IF</pre>
<div class="block">The name of the IF function (i.e. "IF").  Extracted as a constant for clarity.</div>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.poi.ss.formula.function.FunctionMetadataRegistry.FUNCTION_NAME_IF">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FUNCTION_INDEX_IF">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FUNCTION_INDEX_IF</h4>
<pre>public static final&nbsp;int FUNCTION_INDEX_IF</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.poi.ss.formula.function.FunctionMetadataRegistry.FUNCTION_INDEX_IF">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FUNCTION_INDEX_SUM">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FUNCTION_INDEX_SUM</h4>
<pre>public static final&nbsp;short FUNCTION_INDEX_SUM</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.poi.ss.formula.function.FunctionMetadataRegistry.FUNCTION_INDEX_SUM">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FUNCTION_INDEX_CHOOSE">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FUNCTION_INDEX_CHOOSE</h4>
<pre>public static final&nbsp;int FUNCTION_INDEX_CHOOSE</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.poi.ss.formula.function.FunctionMetadataRegistry.FUNCTION_INDEX_CHOOSE">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FUNCTION_INDEX_INDIRECT">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>FUNCTION_INDEX_INDIRECT</h4>
<pre>public static final&nbsp;short FUNCTION_INDEX_INDIRECT</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.poi.ss.formula.function.FunctionMetadataRegistry.FUNCTION_INDEX_INDIRECT">Constant Field Values</a></dd></dl>
</li>
</ul>
<a name="FUNCTION_INDEX_EXTERNAL">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>FUNCTION_INDEX_EXTERNAL</h4>
<pre>public static final&nbsp;short FUNCTION_INDEX_EXTERNAL</pre>
<dl><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../../../constant-values.html#org.apache.poi.ss.formula.function.FunctionMetadataRegistry.FUNCTION_INDEX_EXTERNAL">Constant Field Values</a></dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!--   -->
</a>
<h3>Method Detail</h3>
<a name="getFunctionByIndex(int)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFunctionByIndex</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadata.html" title="class in org.apache.poi.ss.formula.function">FunctionMetadata</a>&nbsp;getFunctionByIndex(int&nbsp;index)</pre>
</li>
</ul>
<a name="lookupIndexByName(java.lang.String)">
<!--   -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>lookupIndexByName</h4>
<pre>public static&nbsp;short&nbsp;lookupIndexByName(java.lang.String&nbsp;name)</pre>
<div class="block">Resolves a built-in function index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - uppercase function name</dd>
<dt><span class="strong">Returns:</span></dt><dd>a negative value if the function name is not found.
 This typically occurs for external functions.</dd></dl>
</li>
</ul>
<a name="getFunctionByName(java.lang.String)">
<!--   -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getFunctionByName</h4>
<pre>public static&nbsp;<a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadata.html" title="class in org.apache.poi.ss.formula.function">FunctionMetadata</a>&nbsp;getFunctionByName(java.lang.String&nbsp;name)</pre>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!--   -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!--   -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/FunctionMetadataRegistry.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../../../../index-all.html">Index</a></li>
<li><a href="../../../../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../../org/apache/poi/ss/formula/function/FunctionMetadata.html" title="class in org.apache.poi.ss.formula.function"><span class="strong">PREV CLASS</span></a></li>
<li>NEXT CLASS</li>
</ul>
<ul class="navList">
<li><a href="../../../../../../index.html?org/apache/poi/ss/formula/function/FunctionMetadataRegistry.html" target="_top">FRAMES</a></li>
<li><a href="FunctionMetadataRegistry.html" target="_top">NO FRAMES</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
  allClassesLink = document.getElementById("allclasses_navbar_bottom");
  if(window==top) {
    allClassesLink.style.display = "block";
  }
  else {
    allClassesLink.style.display = "none";
  }
  //-->
</script>
</div>
<div>
<ul class="subNavList">
<li>SUMMARY:&nbsp;</li>
<li>NESTED&nbsp;|&nbsp;</li>
<li><a href="#field_summary">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_summary">METHOD</a></li>
</ul>
<ul class="subNavList">
<li>DETAIL:&nbsp;</li>
<li><a href="#field_detail">FIELD</a>&nbsp;|&nbsp;</li>
<li>CONSTR&nbsp;|&nbsp;</li>
<li><a href="#method_detail">METHOD</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!--   -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>
                <i>Copyright 2014 The Apache Software Foundation or
        its licensors, as applicable.</i>
            </small></p>
</body>
</html>
